<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>EhaiCMS规范</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <style type="text/css">
        *
        {
            padding: 0;
            margin: 0;
            font-size: 15px;
        }
        .main
        {
            width: 750px;
            margin: 0 auto;
            padding: 15px;
        }
        dt
        {
            font-weight: bold;
            margin-top: 20px;
        }
        dd
        {
            margin-top: 5px;
            line-height: 20px;
        }
        ul
        {
            list-style-type: none;
        }
        .title
        {
            font-size: 25px;
            text-align: center;
            font-weight: bold;
        }
    </style>
</head>
<body style="background-color: #ccc;">
    <div class="main">
        <ul>
            <li class="title">EhaiCMS系统规范</li>
            <li>
                <dl>
                    <dt>一、实现效果</dt>
                    <dd>
                        EhaiCMS系统完成后效果为：
                        <br />
                        &nbsp; &nbsp; &nbsp;用户进入系统后，可以根据类型选择控件，选择每一类型或每一控件后会有相关介绍，看完介绍可以查看demo，以及具体的效果（参数控制），
                        然后是怎样一步步应用到自己的页面中，最后可以提交bug或者给我们留言。
                    </dd>
                </dl>
            </li>
            <li>
                <dl>
                    <dt>二、基本规范</dt>
                    <dd>
                        1、在controls文件夹下，各控件中，凡非控件使用过程中必须文件，文件名必须使用下划线（_）开头，即在使用该控件时，可删除所有下划线开头的文件。</dd>
                    <dd>
                        2、在controls文件夹下，各控件中，分类文件夹下可放置_description.xml文件，保存必要信息。</dd>
                    <dd>
                        3.每个文件夹都可放置一个_intro.xml文件，用于存储文件夹相关信息；</dd>
                    <dd>
                        4.存放的控件的版本要求是最高版本；
                    </dd>
                    <dd>
                        5.所有文件名必须为小写；
                    </dd>
                    <dd>
                        6.下载的打包文件是自动压缩控件所在文件夹生成的，而不是静态的。
                    </dd>
                </dl>
            </li>
            <li><strong>三、文件夹结构</strong>
                <dl>
                    <dt>1.总的文件夹结构：</dt>
                    <dd>
                        <img src="images/folder.png" alt="文件夹结构图" />
                        <br />
                        &nbsp;&nbsp; &nbsp;在总目录EhaiCMS下有四个文件夹、三个html文件和一个xml文件，分别是controls、js、images、css文件夹，index.html、admin.html、standard.htm三个html文件和_intro.xml文件，此结构和所有项目文件夹结构相同。
                        <dl>
                            <dt>controls文件夹：</dt>
                            <dd>
                                &nbsp; &nbsp;&nbsp;它包含四个文件夹page（放置页面型样式及js控制）、control（放置用户控件）、conponent（放置组件）、functional(放置功能性部件)。这四个文件夹下面可有两级目录进行分类，放置更细的分类文件夹和具体插件。
                            </dd>
                            <dt>images文件夹：</dt>
                            <dd>
                                &nbsp; &nbsp;&nbsp;放置“系统”静态页面的相关图片。
                            </dd>
                            <dt>css文件夹：</dt>
                            <dd>
                                &nbsp; &nbsp;&nbsp;放置“系统”静态页面的相关css文件。
                            </dd>
                            <dt>js文件夹：</dt>
                            <dd>
                                &nbsp; &nbsp;&nbsp;放置系统相关的js文件，以及插件中使用到的jQuery文件和一些插件通用的js文件（例如ui.js），在js这个文件夹里面也是按照不同js框架进行分类来放置，例如有一个jQuery文件夹防治。
                            </dd>
                            <dt>index.html：</dt>
                            <dd>
                                &nbsp; &nbsp;&nbsp;本控件系统系统主页，其他系统可根据自己系统需求编写自己主页。
                            </dd>
                            <dt>admin.html：</dt>
                            <dd>
                                &nbsp; &nbsp;&nbsp;管理页面，用于更新插件、管理留言和bug等。
                            </dd>
                            <dt>standard.html：</dt>
                            <dd>
                                &nbsp; &nbsp;&nbsp;各系统各个方面的详细规范，可由主页版权旁边点击链接进入到此页面。
                            </dd>
                            <dt>_intro.xml：</dt>
                            <dd>
                                &nbsp; &nbsp;&nbsp;管理文件夹各种附加信息，便于程序控制，具体结构如下：
                                <ul>
                                    <li>&lt;root&gt; </li>
                                    <li>&nbsp; &nbsp;&nbsp;&lt;title&gt;文件夹名字&lt/title&gt; </li>
                                    <li>&lt/root&gt; </li>
                                </ul>
                            </dd>
                        </dl>
                    </dd>
                    <dt>2.controls下面最后一级具体插件文件夹结构：</dt>
                    <dd>
                        <img src="images/control.png" />
                        <br />
                        &nbsp; &nbsp;&nbsp;每个插件有js、css、images三个文件夹和intro、demo、help、 process、back几个html文件，以及_description.xml、_intro.xml两个xml文件。
                        具体规范如下：
                    </dd>
                    <dl>
                        <dt>images文件夹：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;放置与插件相关的图片
                        </dd>
                        <dt>css文件夹：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;有风格文件夹，比如black、blue和pink，分别放置插件三种风格的css文件。
                        </dd>
                        <dt>js文件夹：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;放置只与插件相关的单独js文件。框架js文件（如jQuery文件）以及一些通用的js文件（如ui.js）放置在EhaiCMS根目录下的js文件夹里面的框架对应的文件夹里。
                        </dd>
                        <dt>_intro.html：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;介绍插件的功能、SVN、官网、版本信息、所使用的jQuery库文件版本号等关于插件的基本信息。
                            <br />
                            必写的参数：插件的功能、官网、版本信息、类型（是否基于jQuery）
                            <br />
                            选写的参数： SVN、所使用的jQuery库文件版本号
                        </dd>
                        <dt>_demo.html：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;演示插件功能，如果插件功能有多个，或插件功能比较丰富，要将插件的所有功能都演示出来， 而且所有例子放在同一个页面中。 当同一个插件放在相同的页面冲突时，即同一个插件在一个页面只能使用一次，需要多页时，用_demo+(数字).html进行命名，如_demo1.html、_demo2.html、_demo3.html等，来取代_demo.html
                        </dd>
                        <dt>_help.html：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;介绍插件的相关参数的含义、使用方法。 当需要写多个帮助时，使用_help+(数字）.html进行命名，如_help1.html、_help2.html、_help3.html等，来取代_help.html
                        </dd>
                        <dt>_process.html：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;详细介绍插件的使用步骤，例如如何将代码插入到页面中，参数如何设置等等。
                        </dd>
                        <dt>_serverdata.html：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;介绍插件如何与后台交互获取后台数据，没有后台的插件可以没有此文件。
                        </dd>
                        <dt>_description.xml：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;管理控件相关信息。具体结构如下：
                            <ul>
                                <li>&lt;root&gt; </li>
                                <li>&nbsp; &nbsp;&nbsp;&lt;title&gt;插件名字&lt/title&gt; </li>
                                <li>&nbsp; &nbsp;&nbsp;&lt;times&gt;访问次数&lt/times&gt; </li>
                                <li>&nbsp; &nbsp;&nbsp;&lt;bugs&gt;<ul>
                                    <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;bug author=&quot;bug提交者&quot; date=&quot;日期&quot;
                                        ip=&quot;ip地址&quot;&gt;</li>
                                    <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
                                        &lt;c&gt;bug内容&lt;/c&gt;</li>
                                    <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
                                        &lt;reply author=&quot;bug提交者&quot; date=&quot;日期&quot; ip=&quot;ip地址&quot;&gt;&lt;/reply&gt;</li>
                                    <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
                                        &lt;reply author=&quot;bug提交者&quot; date=&quot;日期&quot; ip=&quot;ip地址&quot;&gt;&lt;/reply&gt;</li>
                                    <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/bug&gt;</li>
                                </ul>
                                </li>
                                <li>&nbsp;&nbsp;&nbsp; &lt/bugs&gt;</li>
                                <li>&nbsp; &nbsp;&nbsp;&lt;messages&gt;</li>
                                <li>
                                    <ul>
                                        <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;message author=&quot;message提交者&quot;
                                            date=&quot;日期&quot; ip=&quot;ip地址&quot;&gt;</li>
                                        <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
                                            &lt;c&gt;message内容&lt;/c&gt;</li>
                                        <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
                                            &lt;reply author=&quot;bug提交者&quot; date=&quot;日期&quot; ip=&quot;ip地址&quot;&gt;&lt;/reply&gt;</li>
                                        <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
                                            &lt;reply author=&quot;bug提交者&quot; date=&quot;日期&quot; ip=&quot;ip地址&quot;&gt;&lt;/reply&gt;</li>
                                        <li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/message&gt;</li>
                                    </ul>
                                </li>
                                <li>&nbsp;&nbsp;&nbsp; &lt/messages&gt;</li>
                                <li>&lt/root&gt; </li>
                            </ul>
                        </dd>
                        <dt>_intro.xml：</dt>
                        <dd>
                            &nbsp; &nbsp;&nbsp;管理文件夹，便于程序控制，具体结构如下：
                            <ul>
                                <li>&lt;root&gt; </li>
                                <li>&nbsp; &nbsp;&nbsp;&lt;title&gt;文件夹名字&lt/title&gt; </li>
                                <li>&lt/root&gt; </li>
                            </ul>
                        </dd>
                    </dl>
                </dl>
            </li>
        </ul>
    </div>
</body>
</html>
